Skip to content

Conversation

@blathers-crl
Copy link

@blathers-crl blathers-crl bot commented May 12, 2025

Backport 1/1 commits from #146343 on behalf of @srosenberg.


Previously, the environment variable, COCKROACH_SKIP_ENABLING_DIAGNOSTIC_REPORTING=1 was used to disable both telemetry and crash reporting. However, the default for diagnostics.reporting.enabled has flipped from false to true as of [1]. The same PR added a regression wrt to the environment variable–it no longer disabled crash reporting via Sentry.

Recall, we prefer to disable Sentry crash reporting for all tests since our (internal) test artifacts contain a superset of contextual information; i.e., Sentry reports are of limited use for test failures; as such they add more noise than signal.

Also recall, unit tests effectively disable Sentry by not invoking cli.doMain, which invokes SetupCrashReporter. Both integration (docker) and roachtests rely on COCKROACH_SKIP_ENABLING_DIAGNOSTIC_REPORTING=1. Mixedversion logic tests until this change, simply assumed that diagnostics.reporting.enabled defaulted to false.

This change fixes the regression, introduced in [1], by correctly updating diagnostics.reporting.enabled to affect the environment variable. It also sets COCKROACH_CRASH_REPORTS to the empty string, which disables crash reporting before a server is fully initialized.

[1] #131097

Fixes: #145457
Epic: none
Release note: None


Release justification: test-only change

…eporting

Previously, the environment variable, `COCKROACH_SKIP_ENABLING_DIAGNOSTIC_REPORTING=1`
was used to disable both telemetry and crash reporting. However, the default for
`diagnostics.reporting.enabled` has flipped from `false` to `true` as of [1].
The same PR added a regression wrt to the environment variable–it no longer
disabled crash reporting via Sentry.

Recall, we prefer to disable Sentry crash reporting for _all_
tests since our (internal) test artifacts contain a superset
of contextual information; i.e., Sentry reports are of limited
use for test failures; as such they add more noise than signal.

Also recall, unit tests effectively disable Sentry by not invoking
`cli.doMain`, which invokes `SetupCrashReporter`. Both integration (docker)
and roachtests rely on `COCKROACH_SKIP_ENABLING_DIAGNOSTIC_REPORTING=1`.
Mixedversion logic tests until this change, simply assumed that
`diagnostics.reporting.enabled` defaulted to `false`.

This change fixes the regression, introduced in [1], by correctly
updating `diagnostics.reporting.enabled` to affect the environment
variable. It also sets `COCKROACH_CRASH_REPORTS` to the empty string,
which disables crash reporting _before_ a server is fully initialized.

[1] #131097

Fixes: #145457
Epic: none
Release note: None
@blathers-crl blathers-crl bot requested a review from a team as a code owner May 12, 2025 15:24
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-24.3-146343 branch from 8a6d812 to 08cf813 Compare May 12, 2025 15:24
@blathers-crl blathers-crl bot requested review from a team as code owners May 12, 2025 15:24
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels May 12, 2025
@blathers-crl blathers-crl bot requested review from angles-n-daemons and removed request for a team May 12, 2025 15:24
@blathers-crl blathers-crl bot requested review from Abhinav1299, aa-joshi and arjunmahishi and removed request for a team May 12, 2025 15:24
@blathers-crl
Copy link
Author

blathers-crl bot commented May 12, 2025

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Backports should only be created for serious
    issues
    or test-only changes.
  • Backports should not break backwards-compatibility.
  • Backports should change as little code as possible.
  • Backports should not change on-disk formats or node communication protocols.
  • Backports should not add new functionality (except as defined
    here).
  • Backports must not add, edit, or otherwise modify cluster versions; or add version gates.
  • All backports must be reviewed by the owning areas TL. For more information as to how that review should be conducted, please consult the backport
    policy
    .
If your backport adds new functionality, please ensure that the following additional criteria are satisfied:
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters. State changes must be further protected such that nodes running old binaries will not be negatively impacted by the new state (with a mixed version test added).
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.
  • Your backport must be accompanied by a post to the appropriate Slack
    channel (#db-backports-point-releases or #db-backports-XX-X-release) for awareness and discussion.

Also, please add a brief release justification to the body of your PR to justify this
backport.

@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label May 12, 2025
@blathers-crl
Copy link
Author

blathers-crl bot commented May 12, 2025

It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR?

🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@srosenberg
Copy link
Member

TFTR!

@srosenberg srosenberg merged commit 6be9fd5 into release-24.3 May 13, 2025
14 of 15 checks passed
@srosenberg srosenberg deleted the blathers/backport-release-24.3-146343 branch May 13, 2025 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport Label PR's that are backports to older release branches blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. T-testeng TestEng Team v24.3.15

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants